<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - gmwk</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><a href="../symbols/%24.html">$</a></li>
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/gmwk.html">gmwk</a></li>
	
	<li><a href="../symbols/gmwk.classes.html">gmwk.classes</a></li>
	
	<li><a href="../symbols/gmwk.classes.Contact.html">gmwk.classes.Contact</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class gmwk
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				<br />Version
					Beta.<br />
				
				
			
				Go Media Web Kit (GMWK)
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/js_core_gmwk.js.html">gmwk.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class gmwk.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&lt;inner&gt; &nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/gmwk.html#constructor">gmwk</a></b>(Options)
							</div>
							<div class="description"></div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class gmwk.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#clearStage">clearStage</a></b>()
								</div>
								<div class="description">Remove all elements from stage container</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#cloneTemplate">cloneTemplate</a></b>(Name, Name)
								</div>
								<div class="description">Copy template from template cache to the given container.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#closestObjectContainer">closestObjectContainer</a></b>(jqElement)
								</div>
								<div class="description">Find closest object container to a given element</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">gmwk.<b><a href="../symbols/gmwk.html#.compareObjects">compareObjects</a></b>(Obj1, Obj2)
								</div>
								<div class="description">Compare two objects.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#config">config</a></b>()
								</div>
								<div class="description">Configure application and bootstrap, override this function in config.js</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#create">create</a></b>(sClassName, Options)
								</div>
								<div class="description">Create an object instance, fetch class definition if not cached.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;inner&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#-fLoadTemplate">fLoadTemplate</a></b>(sTemplateName)
								</div>
								<div class="description">Synchronously load template from template path and append to the template cache</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#getDebugStatus">getDebugStatus</a></b>()
								</div>
								<div class="description">Get debug status</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#getStageContainer">getStageContainer</a></b>()
								</div>
								<div class="description">Get stage container</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#getTemplate">getTemplate</a></b>(sTemplateName)
								</div>
								<div class="description">Get a cached template from the template container.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#getTemplateContainer">getTemplateContainer</a></b>()
								</div>
								<div class="description">Get template container</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#getVersion">getVersion</a></b>()
								</div>
								<div class="description">Get application version, return random string if not in live environment</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">gmwk.<b><a href="../symbols/gmwk.html#.objectLength">objectLength</a></b>(Obj)
								</div>
								<div class="description">Determine object length as the number of properties, non recursive.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#run">run</a></b>()
								</div>
								<div class="description">Entry point into the application, called when DOM is ready</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setDebugStatus">setDebugStatus</a></b>(bMyDebugStatus)
								</div>
								<div class="description">If debug status is false global console object will be overwritten</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setLiveEnvironment">setLiveEnvironment</a></b>(bMyLiveEnvironment)
								</div>
								<div class="description">If live environment is false getVersion returns a random string</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setLocalClassPath">setLocalClassPath</a></b>(sMyLocalLibPath)
								</div>
								<div class="description">Set path to Javascript classes specific to an application</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setSharedClassPath">setSharedClassPath</a></b>(sMyLibPath)
								</div>
								<div class="description">Set path to shared Javascript classes</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setStageContainer">setStageContainer</a></b>(jqMyStageContainer)
								</div>
								<div class="description">The element that is used as the stage container</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setTemplateCache">setTemplateCache</a></b>(jqMyTemplateContainer)
								</div>
								<div class="description">The element that is used as the template cache.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setTemplatePath">setTemplatePath</a></b>(sMyTemplatePath)
								</div>
								<div class="description">Set path to HTML templates</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#setVersion">setVersion</a></b>(sMyVersion)
								</div>
								<div class="description">Set application version, used to control browser cache on live site</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">gmwk.<b><a href="../symbols/gmwk.html#.utils">utils</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/gmwk.html#utils">utils</a></b>()
								</div>
								<div class="description">Extend GMWK with application specific utility functions, see utils.js</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">&lt;inner&gt; 
						<b>gmwk</b>(Options)
				</div>
				
				<div class="description">
					
					<br /><i>Author: </i>Go Media www.gomedia.co.za | info@gomedia.co.za.
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{Object}</span>  <b>Options</b>
								
							</dt>
								<dd>Constructor options</dd>
						
							<dt>
								<span class="light fixedFont">{String}</span>  <b>Options.sTemplatePath</b>
								
							</dt>
								<dd>Path to HTML templates</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="clearStage"> </a>
					<div class="fixedFont">
					
					
					<b>clearStage</b>()
					
					</div>
					<div class="description">
						Remove all elements from stage container
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="cloneTemplate"> </a>
					<div class="fixedFont">
					
					<span class="light">{jQuery}</span>
					<b>cloneTemplate</b>(Name, Name)
					
					</div>
					<div class="description">
						Copy template from template cache to the given container.
   Each template will be given a unique ID with format: "gmwk_" + sTemplateName + "_" + nTemplateCounter.
   Each template will also be given the class "gmwk_object_container"
   TODO: Create third parameter Options to insert clone at different positions in jqContainer.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{sTemplateName}</span> <b>Name</b>
									
								</dt>
								<dd>of the template to clone</dd>
							
								<dt>
									<span class="light fixedFont">{jqContainer}</span> <b>Name</b>
									
								</dt>
								<dd>of the container to clone the template in</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{jQuery}</span> Reference to the cloned template container</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="closestObjectContainer"> </a>
					<div class="fixedFont">
					
					<span class="light">{jQuery}</span>
					<b>closestObjectContainer</b>(jqElement)
					
					</div>
					<div class="description">
						Find closest object container to a given element
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{jQuery}</span> <b>jqElement</b>
									
								</dt>
								<dd>Search from this element</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{jQuery}</span> The closest element with class "gmwk_object_container"</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".compareObjects"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">gmwk.</span><b>compareObjects</b>(Obj1, Obj2)
					
					</div>
					<div class="description">
						Compare two objects.
   TODO: Does not support nested objects or arrays
   TODO: Could be more efficient?
						
							<br />
							<i>Defined in: </i> <a href="../symbols/src/js_core_utils.js.html">utils.js</a>.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>Obj1</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>Obj2</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> True if objects have exact same properties</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="config"> </a>
					<div class="fixedFont">
					
					
					<b>config</b>()
					
					</div>
					<div class="description">
						Configure application and bootstrap, override this function in config.js
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="create"> </a>
					<div class="fixedFont">
					
					
					<b>create</b>(sClassName, Options)
					
					</div>
					<div class="description">
						Create an object instance, fetch class definition if not cached.
   Try to fetch class definition from local library path first.
   If not found then try to fetch from shared library.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>sClassName</b>
									
								</dt>
								<dd>Name of the class to create an instance of, case sensitive</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>Options</b>
									
								</dt>
								<dd>Options will be passed to class contructor</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="-fLoadTemplate"> </a>
					<div class="fixedFont">&lt;inner&gt; 
					
					
					<b>fLoadTemplate</b>(sTemplateName)
					
					</div>
					<div class="description">
						Synchronously load template from template path and append to the template cache
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>sTemplateName</b>
									
								</dt>
								<dd>Name of the template to load</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="getDebugStatus"> </a>
					<div class="fixedFont">
					
					<span class="light">{Boolean}</span>
					<b>getDebugStatus</b>()
					
					</div>
					<div class="description">
						Get debug status
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> Debug status</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getStageContainer"> </a>
					<div class="fixedFont">
					
					<span class="light">{jQuery}</span>
					<b>getStageContainer</b>()
					
					</div>
					<div class="description">
						Get stage container
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{jQuery}</span> Stage container</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getTemplate"> </a>
					<div class="fixedFont">
					
					<span class="light">{jQuery}</span>
					<b>getTemplate</b>(sTemplateName)
					
					</div>
					<div class="description">
						Get a cached template from the template container.
   If the template is not cached load it from the template path.
   Use cloneTemplate to insert a template into the stage.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>sTemplateName</b>
									
								</dt>
								<dd>Name of the template.
   Template names should preferably match a class name.
   It is not required, and some classes may have many templates.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{jQuery}</span> Cached template</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getTemplateContainer"> </a>
					<div class="fixedFont">
					
					<span class="light">{jQuery}</span>
					<b>getTemplateContainer</b>()
					
					</div>
					<div class="description">
						Get template container
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{jQuery}</span> Template container</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getVersion"> </a>
					<div class="fixedFont">
					
					
					<b>getVersion</b>()
					
					</div>
					<div class="description">
						Get application version, return random string if not in live environment
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name=".objectLength"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">gmwk.</span><b>objectLength</b>(Obj)
					
					</div>
					<div class="description">
						Determine object length as the number of properties, non recursive.
   TODO: Extend to count all properties recursively
						
							<br />
							<i>Defined in: </i> <a href="../symbols/src/js_core_utils.js.html">utils.js</a>.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<b>Obj</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="run"> </a>
					<div class="fixedFont">
					
					
					<b>run</b>()
					
					</div>
					<div class="description">
						Entry point into the application, called when DOM is ready
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="setDebugStatus"> </a>
					<div class="fixedFont">
					
					
					<b>setDebugStatus</b>(bMyDebugStatus)
					
					</div>
					<div class="description">
						If debug status is false global console object will be overwritten
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>bMyDebugStatus</b>
									<i>Optional, Default: true</i>
								</dt>
								<dd>Debug status</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setLiveEnvironment"> </a>
					<div class="fixedFont">
					
					
					<b>setLiveEnvironment</b>(bMyLiveEnvironment)
					
					</div>
					<div class="description">
						If live environment is false getVersion returns a random string
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>bMyLiveEnvironment</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd>Live environment</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setLocalClassPath"> </a>
					<div class="fixedFont">
					
					
					<b>setLocalClassPath</b>(sMyLocalLibPath)
					
					</div>
					<div class="description">
						Set path to Javascript classes specific to an application
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>sMyLocalLibPath</b>
									<i>Optional, Default: "js/classes/"</i>
								</dt>
								<dd>Path to classes</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setSharedClassPath"> </a>
					<div class="fixedFont">
					
					
					<b>setSharedClassPath</b>(sMyLibPath)
					
					</div>
					<div class="description">
						Set path to shared Javascript classes
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>sMyLibPath</b>
									<i>Optional, Default: "js/classes/"</i>
								</dt>
								<dd>Path to shared classes</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setStageContainer"> </a>
					<div class="fixedFont">
					
					
					<b>setStageContainer</b>(jqMyStageContainer)
					
					</div>
					<div class="description">
						The element that is used as the stage container
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{jQuery}</span> <b>jqMyStageContainer</b>
									
								</dt>
								<dd>Stage container wrapped in jQuery</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setTemplateCache"> </a>
					<div class="fixedFont">
					
					
					<b>setTemplateCache</b>(jqMyTemplateContainer)
					
					</div>
					<div class="description">
						The element that is used as the template cache.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{jQuery}</span> <b>jqMyTemplateContainer</b>
									
								</dt>
								<dd>Template cache container wrapped in jQuery</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setTemplatePath"> </a>
					<div class="fixedFont">
					
					
					<b>setTemplatePath</b>(sMyTemplatePath)
					
					</div>
					<div class="description">
						Set path to HTML templates
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>sMyTemplatePath</b>
									<i>Optional, Default: "templates/"</i>
								</dt>
								<dd>Path to templates</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="setVersion"> </a>
					<div class="fixedFont">
					
					
					<b>setVersion</b>(sMyVersion)
					
					</div>
					<div class="description">
						Set application version, used to control browser cache on live site
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>sMyVersion</b>
									<i>Optional, Default: "0.1"</i>
								</dt>
								<dd>Application version</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".utils"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">gmwk.</span><b>utils</b>()
					
					</div>
					<div class="description">
						
						
							<br />
							<i>Defined in: </i> <a href="../symbols/src/js_core_utils.js.html">utils.js</a>.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="utils"> </a>
					<div class="fixedFont">
					
					
					<b>utils</b>()
					
					</div>
					<div class="description">
						Extend GMWK with application specific utility functions, see utils.js
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Tue Mar 08 2011 12:56:27 GMT+0200 (SAST)
		</div>
	</body>
</html>
